home *** CD-ROM | disk | FTP | other *** search
/ Language/OS - Multiplatform Resource Library / LANGUAGE OS.iso / cpp_libs / linklist / source.lha / doc / lDef.3 < prev    next >
Text File  |  1993-08-08  |  1KB  |  44 lines
  1. '.so tmac.clman
  2. .TH "lDef"
  3. .IX lDef
  4. .SH NAME
  5. lDef - Define linked list.
  6. .SH SYNOPSIS
  7. int
  8. .BR "lDef" "(sd, cc)"
  9. .br
  10. .RT
  11. .RP
  12. In    int    sd    singly or doubly linked list
  13. .br
  14. .RP
  15. In    int    cc    chain or circular linked list
  16. .DT
  17. .SH DESCRIPTION
  18. To define a linked list use \fBlDef\fP. It is possible to define a
  19. singly or doubly linked list and a chain or circular linked list.
  20. The routine returns the identifier of the defined linked list (\(>= 1),
  21. which must be used in the other routines of the linked list tool.
  22. .SH PARAMETER DEFINITIONS
  23. .if t .ta 0.2i 1.5i
  24. \fIsd\fP :
  25. .nf
  26.     lSINGLY    singly linked list, each node points to the next node
  27.     lDOUBLY    doubly linked list, each node points to the previous and
  28.         the next node
  29. .fi
  30. \fIcc\fP :
  31. .nf
  32.     lCHAIN    chain linked list, last node has a NULL-pointer
  33.     lCIRCULAR    circular linked list, last node points back to the first node
  34. .fi
  35. .SH RETURN CODES
  36. .nf
  37. Return on success :
  38.     identifier of linked list (\(>= 1)
  39. Return on error :
  40.     lWRONG_SD, lWRONG_CC
  41. .fi
  42. .SH AUTHOR
  43. Anita Eijs (TNO - Bouw - BouwInformatica)
  44.